/*
 * Copyright (C) 2010-2011 Comcast Cable.  All Rights Reserved.
 */
package com.hercules.android.receiver.model.events;

/**
 * <p>This is a subclass of XREEvent that represents the set of playback state reporting events.</p>
 *
 * <p><strong>Thread safety:</strong> This class is mutable and not thread safe.</p>
 *
 * @author saarixx, jmn
 * @version 1.0
 */
public class XREStreamPlaybackStateEvent extends XREResourceEvent {

    /**
     * <p>Represents the name of the "on stream playing" event.</p>
     *
     * <p>This is a string constant used by the user when setting the name of the event.</p>
     */
    public static final String ON_STREAM_PLAYING_EVENT_NAME = "onStreamPlaying";

    /**
     * <p>Represents the name of the "on stream paused" event.</p>
     *
     * <p>This is a string constant used by the user when setting the name of the event.</p>
     */
    public static final String ON_STREAM_PAUSED_EVENT_NAME = "onStreamPaused";

    /**
     * <p>Represents the name of the "on stream buffering" event.</p>
     *
     * <p>This is a string constant used by the user when setting the name of the event.</p>
     */
    public static final String ON_STREAM_BUFFERING_EVENT_NAME = "onStreamBuffering";

    /**
     * <p>Represents the name of the "on stream closed" event.</p>
     *
     * <p>This is a string constant used by the user when setting the name of the event.</p>
     */
    public static final String ON_STREAM_CLOSED_EVENT_NAME = "onStreamClosed";

    /**
     * <p>Represents the name of the "on stream complete" event.</p>
     *
     * <p>This is a string constant used by the user when setting the name of the event.</p>
     */
    public static final String ON_STREAM_COMPLETE_EVENT_NAME = "onStreamComplete";

    /**
     * <p>Creates new instance of {@link XREStreamPlaybackStateEvent} class.</p>
     */
    public XREStreamPlaybackStateEvent() {
        // empty constructor
    }
}

